/* ===================

AX2E (AXESCON XACML 2.0 Engine) is the Java authorization engine, which implements OASIS XACML 2.0 standard.
Copyright (C) 2007 AXESCON LLC

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA


Contact: AXESCON LLC - info{at}axescon.com

 =================== */
/*
 * XML Type:  Result
 * Namespace: urn:oasis:names:tc:xacml:2.0:context:schema:os
 * Java type: Result
 *
 * Automatically generated - do not modify.
 */
package axescon.xacml.model.ctx;

import axescon.xacml.model.explain.Explanation;
import axescon.xacml.model.policy.Obligation;
import axescon.xacml.api.XacmlException;

import java.util.List;


/**
 * @author argyn
 * Responsibilities: represents XACML Context Result element,
 * (@urn:oasis:names:tc:xacml:2.0:context:schema:os).
 * <p/>
 */
public interface Result extends axescon.xacml.model.ModelObject {


    /**
     * Gets the byte value of "Decision" element
     */
    byte getDecision();

    /**
     * Gets the String value of "Decision" element
     * @return String value of "Decision" element
     */
    String getDecisionString();

    /**
     * Sets the "Decision" element
     */
    void setDecision(byte decision);

    /**
     * Gets the "Status" element
     */
    Status getStatus();

    /**
     * Sets the "Status" element
     */
    void setStatus(Status status);

    /**
     * Gets the List<Obligation>
     */
    List getObligationList();

    /**
     * Sets the "Obligations" element
     */
    void setObligationArray(Obligation[] obligationArray);

    /**
     * Sets the "Obligations" element.
     * this should add only those Obligations , which match the decision
     * see xacml specification 2.0 ch 7.14 Obligations
     */
    void addObligationArray(Obligation[] obligationArray);

    /**
     * Gets the "ResourceId" attribute
     */
    java.lang.String getResourceId();

    /**
     * Sets the "ResourceId" attribute
     */
    void setResourceId(java.lang.String resourceId);

    /**
     * explanation of the decision, optional feature, not necessarily enabled in std package
     *
     * @return  explanation
     */
    Explanation getExplanation();

    /**
     * sets explanation of a result decision
     * @param explanation
     */
    void setExplanation(Explanation explanation);

    /**
     * get exception, if the result is indeterminate
     * @return exception
     */
    XacmlException getXacmlException();

    /**
     * sets exception, when result is indeterminate
     * @param e exception
     */
    void setXacmlException(XacmlException e);
}
